// Copyright (c) 2002 Graz University of Technology. All rights reserved.
// 
// Redistribution and use in source and binary forms, with or without modification,
// are permitted provided that the following conditions are met:
// 
// 1. Redistributions of source code must retain the above copyright notice, this
//    list of conditions and the following disclaimer.
// 
// 2. Redistributions in binary form must reproduce the above copyright notice,
//    this list of conditions and the following disclaimer in the documentation
//    and/or other materials provided with the distribution.
// 
// 3. The end-user documentation included with the redistribution, if any, must
//    include the following acknowledgment:
// 
//    "This product includes software developed by IAIK of Graz University of
//     Technology."
// 
//    Alternately, this acknowledgment may appear in the software itself, if and
//    wherever such third-party acknowledgments normally appear.
// 
// 4. The names "Graz University of Technology" and "IAIK of Graz University of
//    Technology" must not be used to endorse or promote products derived from this
//    software without prior written permission.
// 
// 5. Products derived from this software may not be called "IAIK PKCS Wrapper",
//    nor may "IAIK" appear in their name, without prior written permission of
//    Graz University of Technology.
// 
// THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED
// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE LICENSOR BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
// OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
// OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
// ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
// OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
// OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.

package ostt1_TokenLib;

//import java.security.PrivateKey;

import iaik.pkcs.pkcs11.objects.PrivateKey;

/**
 * This is an adapter class that allows to use token keys as JCA private keys.
 * An application can use this class whereever an interface requires the
 * application to pass an JCA private key; e.g. for signing.
 */
public class TokenPrivateKey implements java.security.PrivateKey {

	/**
	 * 
	 */
	private static final long serialVersionUID = 6595009029121137246L;
	/**
	 * The PKCS#11 private key of this object.
	 */
	protected PrivateKey tokenPrivateKey_;

	/**
	 * Create a new JCA private key that uses the given PKCS#11 private key
	 * internally.
	 *
	 * @param tokenPrivateKey The PKCS#11 private key that this object refers to.
	 * @preconditions
	 * @postconditions
	 */
	public TokenPrivateKey(PrivateKey tokenPrivateKey) {
		tokenPrivateKey_ = tokenPrivateKey;
	}

	/**
	 * Just returns null.
	 *
	 * @return null.
	 * @preconditions
	 * @postconditions (result == null)
	 */
	public String getAlgorithm() {
		return null;
	}

	/**
	 * Just returns null.
	 *
	 * @return null.
	 * @preconditions
	 * @postconditions (result == null)
	 */
	public String getFormat() {
		return null;
	}

	/**
	 * Just returns null.
	 *
	 * @return null.
	 * @preconditions
	 * @postconditions (result == null)
	 */
	public byte[] getEncoded() {
		return null;
	}

	/**
	 * Returns the PKCS#11 private key object that this object refers to.
	 *
	 * @return The KCS#11 private key object that this object refers to.
	 * @preconditions
	 * @postconditions
	 */
	public PrivateKey getTokenPrivateKey() {
		return tokenPrivateKey_;
	}

}
